home *** CD-ROM | disk | FTP | other *** search
/ Light ROM 3 / Light ROM 3 - Disc 2.iso / programs / amiga / dps / par252.lha / par / ARexx.DOC next >
Text File  |  1994-12-01  |  15KB  |  569 lines
  1. ARexx: (address is DDR)
  2.  
  3. F1.ddr through F10.ddr (S1.ddr - S10.ddr = Shift+FKey) can be run from the F-keys.
  4.  
  5. Note: All examples assume current address is "DDR" (Address DDR), and result
  6. option is set (Options results).  The SAY command is only for programs run
  7. from a shell.  You won't see anything if it's run from PAR.
  8. [] = optional argument
  9. <> = required argument
  10.  
  11. Command Args            Results
  12. -------------------------------------------------------------
  13. APPEND    [ OFF | ON ]        OFF | ON
  14.     Turn append on/off
  15.  
  16.  
  17.  /* enable append mode */
  18.  Append On
  19.  if result~='ON' then say 'Append enable failed.  Select an anim first.'
  20.  
  21. -------------------------------------------------------------
  22. CAV    [ MII | BETA ]        MII | BETACAM
  23.     Set output mode.
  24.  
  25.  /* Switch CAV output gain to Betacam */
  26.  CAV Betacam
  27.  
  28. -------------------------------------------------------------
  29. CHECK <no arg>            OPEN | CLOSED number
  30.  
  31. Returns DOS anim build window status, and current frame.
  32.  
  33. -------------------------------------------------------------
  34. CLEANUP <no arg>
  35.     Optimize the disk.
  36.  
  37.  /* Optimize the PAR disk */
  38.  Cleanup
  39.  
  40. -------------------------------------------------------------
  41. COLORS <hex numbers>
  42.  
  43.  Colors 555 000 999 500 /* Set the screen color palette */
  44.  
  45. -------------------------------------------------------------
  46. COPY    <source> <destination> [start] [end]    1 = success
  47.     Copies source anim/still to destination
  48.     If destination project does not exist, it is created.
  49.  
  50.  Copy 'DD0:Anims/Test' 'DD1:Anims'        /* copy entire anim */
  51.  Copy 'DD0:Anims/Test' 'DD1:Anims' 20 199    /* copy 180 frames  */
  52.  
  53. -------------------------------------------------------------
  54. DELETE    [file] [start] [end]
  55.     delete cuurently selected file or specified file
  56.     or frames in an animation
  57.  
  58.  /* Select the file named "test" in project "Project1", and delete it */
  59.  Project 'Project1'
  60.  File 'test'
  61.  Delete
  62.  -or-
  63.  Delete 'DDR:Project1/test'
  64.  
  65.  Delete 'DDR:Project1/test' 10 20  /* delete frames 10,11...20 */
  66.  
  67. See also: Project, File
  68. -------------------------------------------------------------
  69. DONE    [name]
  70.     Same as hitting done in the DOS animation build status requester.
  71.     name is the optional name to save it as.
  72.     (This command is also used for manual record, without the filename)
  73.  
  74.  /* Set convert mode to anim, convert all framestores, complete the anim */
  75.  Mode Anim
  76.  Address command 'Copy DH1:FrameStore/#? 'DDR:Project1/TestAnim'
  77.  Done
  78.  
  79. See also: Mode
  80. -------------------------------------------------------------
  81. DOSSELECT [stem]
  82.     returns all selected files in DOS requester.
  83.  
  84.     stem.0 => number of selected files
  85.     stem.1 => first selected file (filenames, without path)
  86.  
  87.  DosSelect files
  88.  if files.0~=0 then do i=1 to files.0
  89.     req files.i 'is selected'
  90.  end
  91.  
  92. -------------------------------------------------------------
  93. EMODE    [FRAME | 1 | 2 | BOTH ] [DOUBLE]    FRAME|1|2|BOTH  DOUBLE
  94.     Set current export mode
  95.  
  96. EMode FRAME    /* saves full 480 line frame. */
  97. EMode 1     /* saves field 1 as a 240 line file. */
  98. EMode BOTH    /* saves both 240 line fields as separate files. */
  99. EMode 1 DOUBLE    /* saves field 1 as a 480 line file. (every 2 lines are the same) */
  100.  
  101. See also: Export, Exporter
  102. -------------------------------------------------------------
  103. EMULATE [ OFF | ON ]        OFF | ON
  104.     Turn emulation off or on.
  105.  
  106.   EMULATE ON
  107.  
  108. -------------------------------------------------------------
  109. ENDFRAME <number>
  110.     Set playback endframe (0 or OFF to turn off)
  111.  
  112.  ENDFRAME 200
  113.  
  114. See also: StartFrame, Loop, Play
  115. -------------------------------------------------------------
  116. ETOE    [ OFF | ON ]        OFF | ON
  117.  
  118.  /* Check the status of E/E */
  119.  ETOE
  120.  Say 'E/E is:' result
  121.  
  122. -------------------------------------------------------------
  123. EXPORT    [output_name] [start] [end] [start_ext]
  124.     Save frames to curent DOS path as IFF24 or PAR images.
  125.     OUTPUT_NAME changes the name of the output files (do not specify path).
  126.     START and END are the range of frame for an anim.
  127.     START_EXT is the starting number to use as the extension.
  128.  
  129.  Export          /* Export still or current frame of anim */
  130.  Export 10      /* Export frame 10 of anim */
  131.  Export 1 30      /* Export frames 1 to 30 */
  132.  Export test 1 10 /* Export any name as test.0001, test.0002, ....
  133.  Export test 120 130 400 /*Exports frame 120-130 as test.0400, test.0401, ....
  134.  
  135. See also: EMode, Path, Exporter
  136. -------------------------------------------------------------
  137. EXPORTER [name]
  138.     Set export format
  139.  
  140.  Exporter IFF
  141.  EMode    FRAME
  142.  Export   1 30
  143.  
  144. -------------------------------------------------------------
  145. FILE    [name]            current file name
  146.     Set file selection/play still or first frame of anim.
  147.  
  148.  /* Switch to the "TestPatterns" project, show the still named "SMPTE_Bars" */
  149.  Project 'TestPatterns'
  150.  if result='' then say 'That project does not exist.'
  151.  File 'SMPTE_Bars'
  152.  if result='' then say 'That file does not exist.'
  153.  -or-
  154.  File 'DD1:Anims/Test1' /* optionally, the full path may be given */
  155.  
  156. See also: Project, Unit
  157. -------------------------------------------------------------
  158. FILTER    [ OFF | ON ]        OFF | ON
  159.     Set IFF conversion filter mode.
  160.  
  161.  /* Turn filter on */
  162.  Filter On
  163.  
  164. -------------------------------------------------------------
  165. FIELD    [ 1 | 2 ]        1 | 2
  166.     Set field to display.
  167.  
  168.  
  169.  Stunt On    /* enable field display */
  170.  Field 2    /* show field 2 */
  171.  
  172. See also: Stunt
  173. -------------------------------------------------------------
  174. FILM    [ OFF | ON ]        OFF | ON
  175.     Turn film mode (24 fps) on or off.
  176.  
  177.  /* Turn on film mode */
  178.  Film On
  179.  
  180. -------------------------------------------------------------
  181. FPS    [number]        number
  182.     Set frames per second playback, or record FPS.
  183.     SLOW must be set to activate variable playback.
  184.  
  185.  /* Play an anim at 7.5 frames per second, and wait for end. */
  186.  FPS 7.5
  187.  Slow ON
  188.  Loop OFF
  189.  Play 'TestAnim'
  190.  Wait
  191.  Slow OFF
  192.  
  193. -------------------------------------------------------------
  194. FRAMES    <no arg>        number of frames
  195.     Get number of frames in currently loaded anim.
  196.  
  197.  File 'DD0:Anims/TestAnim'
  198.  Frames
  199.  n=result
  200.  if n=0 then Say 'Not an anim.'
  201.  else Say 'Anim has' n 'frames.'
  202.  
  203. -------------------------------------------------------------
  204. FREE    <no arg>        number of blocks
  205.  
  206.  Free
  207.  say 'The largest freespace is' result
  208. -------------------------------------------------------------
  209. GENLOCK [ INT | EXT ]        INT | EXT
  210.     Set sync reference mode.
  211.  
  212. -------------------------------------------------------------
  213. GPI    [ ON | OFF ]        ON | OFF
  214.  
  215.     Turn GPI trigger on or off.
  216.  
  217. -------------------------------------------------------------
  218. GRAB    [filename]
  219.     Grab a live frame.  Will request a name if not given.
  220.  
  221.  /* grab 8 frames from video source named "Test.1" thru "Test.8"
  222.  do i=1 to 8
  223.     Grab 'Test.'i
  224.  end
  225.  
  226. -------------------------------------------------------------
  227. HORIZ    [number]        number
  228.  
  229.  /* Set genlock horizontal to .28 deg. */
  230.  Horiz 0.28
  231.  
  232. -------------------------------------------------------------
  233. JOIN    <name> <name> [name] ...
  234.     Join a list of anim files together.
  235.     The first name will be used as the joined name.
  236.  
  237.  /* Join the files "test" and "test2" in the project "main" */
  238.  Join 'DD0:main/test' 'DD0:main/test2' 'DD1:Anims/endanim'
  239.  
  240.  
  241. -------------------------------------------------------------
  242. JUMP    [frame]         frame
  243.     Jump to frame number in anim/get current frame number (0=no anim)
  244.  
  245.  /* Load "TestAnim" and show frame 30 if it's an anim */
  246.  File 'TestAnim'
  247.  Jump
  248.  if result=0 then say 'This is not an anim'
  249.  else Jump 30
  250.  
  251. -------------------------------------------------------------
  252. LAPSE    OFF | ON | seconds
  253.     Set record time lapse speed, and turn on/off
  254.  
  255.  /* Record time-lapse, and play it. Always set Lapse, QFactor, and RecFrames */
  256.  Lapse On
  257.  Lapse 4
  258.  QFactor 10
  259.  RecFrames 30
  260.  Record 'LapseTest1'
  261.  Play
  262.  
  263. -------------------------------------------------------------
  264. LIMIT    [number]        number
  265.     Set anim frame max encode size in blocks.
  266.  
  267.  /* set maximum frames size limit for record/convert */
  268.  Limit 156
  269.  
  270. -------------------------------------------------------------
  271. LOOP    [ OFF | ON ]        OFF | ON
  272.     Set anim looping mode.
  273.  
  274.  /* Play current anim over and over again */
  275.  Loop On
  276.  Play
  277.  
  278. -------------------------------------------------------------
  279. MANUAL    [ OFF | ON ]        OFF | ON
  280.     Enable manual record
  281.  
  282.  /* record a few frames */
  283.  RecFrames 10
  284.  Manual ON
  285.  QFactor 12
  286.  Record 'testfile'
  287.  Step /* same as hitting the GRAB button, or GPI */
  288.  Step
  289.  Step
  290.  Done /* same as hitting the DONE button */
  291.  
  292. -------------------------------------------------------------
  293. MODE    [ STILL | ANIM ]    Still | Anim
  294.     Set import mode.
  295.  
  296.  /* Import a framestore as a still */
  297.  Mode still
  298.  Address command 'Copy DH1:FrameStore/000.FS.VT4000 DDR:Stills'
  299.  
  300. -------------------------------------------------------------
  301. MONO    [OFF | ON]        [OFF | ON]
  302.     Turn monochrome on or off.
  303.  
  304. -------------------------------------------------------------
  305. MOVE    <source> <destination>        1 = success
  306.     Moves source anim/still to destination
  307.     If destination project does not exist, it is created.
  308.  
  309.  Move 'DD0:Anims/Test' 'DD1:Anims'
  310.  
  311. -------------------------------------------------------------
  312. PATH    [dos_path]        dos_path
  313.     Set path in AmigaDOS file selector.
  314.  
  315.  /* Change DOS selector to RAM: directory */
  316.  Path 'RAM:'
  317.  
  318. -------------------------------------------------------------
  319. PAUSE    [ OFF | ON | number ]    OFF | ON
  320.     Set pause state
  321.     If a number is given, it will unpause, wait until that frame, then pause.
  322.  
  323.  /* Play selected anim, pause at frame 30, wait 1 sec, pause at 60, and stop at 90 */
  324.  Play
  325.  Pause 30
  326.  call delay 50
  327.  Pause 60
  328.  call delay 50
  329.  Stop 90
  330.  
  331. -------------------------------------------------------------
  332. PLAY    [filename]            0 | 1
  333.     Show still/Start playing current anim, or start playing [filename]
  334.     in current project.
  335.  
  336.  /* play some anims at 30 FPS in sequence, waiting for each to end */
  337.  Project 'Anims'
  338.  Loop off
  339.  FPS 30
  340.  Play 'Anim1'
  341.  if result=0 then do;say 'Can''t play.  File does not exist.';exit;end
  342.  Wait
  343.  Play 'Anim2'
  344.  Wait
  345.  Play 'Anim3'
  346.  Wait
  347.  Play 'DD1:OtherProject/Anim4' /* optionally give full path */
  348.  
  349. -------------------------------------------------------------
  350. PROJECT [name]            curent project name
  351.     Set project selection.
  352.  
  353.  Project 'Project1'
  354.  if result='' then Say 'No project by that name'
  355.  
  356. -------------------------------------------------------------
  357. QFACTOR 0-23            0-23
  358.     Set Q-Factor
  359.  
  360. -------------------------------------------------------------
  361. QUIT    <no arg>
  362.     Quit PAR
  363.  
  364. -------------------------------------------------------------
  365. RECFRAMES [number]        number
  366.     Set number of frames for real-time record.  Return value may be lower
  367.     than requested depending on free space.
  368.  
  369. -------------------------------------------------------------
  370. RECORD    [filename]
  371.     Starts record. Asks for filename if not given.
  372.  
  373.  /* record 90 frames real-time at full speed */
  374.  Lapse OFF
  375.  RecFrames 90
  376.  QFactor 11
  377.  FPS 30
  378.  Record 'Movie'
  379.  
  380. -------------------------------------------------------------
  381. REQUEST <line1|line2|line3;editline>  0 | 1 | editline
  382.     Open an OK/Cancel or string requester
  383.  
  384.  /* Request things.  Intended to be run from a shell on Workbench */
  385.  ToFront
  386.  Req 'Would you like to continue?'
  387.  if result=1 then say 'You hit the OK button.'
  388.  else say 'You hit the Cancel button.'
  389.  ToBack
  390.  
  391.  ToFront
  392.  Req 'Edit the string and hit return.|Hit Cancel to return "".;Test string'
  393.  if result='' then say 'Cancel'
  394.  else say 'The edit line was "'result'"'
  395.  ToBack
  396.  
  397. -------------------------------------------------------------
  398. SLOW    [ OFF | ON ]        OFF | ON
  399.     Turn slow motion on/off.
  400.  
  401.  /* Play anim at 15 FPS */
  402.  FPS 15
  403.  Slow ON
  404.  Loop off
  405.  Play
  406.  if result=1 then say 'Playing....'
  407.  Wait
  408.  Say 'Stopped'
  409.  
  410. -------------------------------------------------------------
  411. SMPTE    [ OFF | ON | time ]    HH:MM:SS:FF ON | OFF
  412.  
  413.  /* Start playing when Studio SMPTE counter reaches one second. */
  414.  SMPTE 01:00
  415.  SMPTE ON
  416.  Pause ON
  417.  Play
  418.  
  419. -------------------------------------------------------------
  420. SPLIT    <number> [filename]
  421.     Split current anim at frame <number>.  If no filename is
  422.     given, it will request one.
  423.  
  424.  /* Split the file "test" at frame 20, leaving file "test" with 20 frames,
  425.     and "test2" with the rest. */
  426.  File 'ddr:anims/test'
  427.  Split 20 'test2'
  428.  
  429. -------------------------------------------------------------
  430. STARTFRAME <number>
  431.     Set playback startframe (0 or OFF to turn off)
  432.  
  433.  /* loop from frame 10 to 30 */
  434.  Startframe 10
  435.  Endframe 30
  436.  Loop ON
  437.  Play
  438.  
  439. See also: Endframe,play
  440. -------------------------------------------------------------
  441. STEP    <no args>        0 | 1 (1=done)
  442.     Frame step durring manual record.
  443.  
  444.  /* record 30 frames, one per second */
  445.  Manual ON
  446.  RecFrames 30
  447.  Record 'live_test'
  448.  done=0
  449.  do while done=0
  450.     Step
  451.     done=result
  452.     call delay 50
  453.  end
  454.  
  455. See also: Manual,Record,Done
  456. -------------------------------------------------------------
  457. STOP    [number]
  458.     Stop playing. If a number is given, it will wait until that frame
  459.     before stopping.
  460.  
  461.  /* Jump to the beginning, start playing, stop at frame 30 */
  462.  Jump 1
  463.  Play
  464.  Stop 30
  465.  
  466. See also: jump,play,pause
  467. -------------------------------------------------------------
  468. STUNT    [ OFF | ON ]        OFF | ON
  469.     Set field/frame output mode.
  470.  
  471. See also: Field
  472. -------------------------------------------------------------
  473. SUB    [number]        number
  474.     Set genlock sub-carrier
  475.  
  476. See also: Horiz
  477. -------------------------------------------------------------
  478. TITLE    [string]
  479.     Put text in the title bar.  No text resets to default.
  480.  
  481.  Title 'Hello'
  482.  call delay 150
  483.  Title
  484.  
  485. -------------------------------------------------------------
  486. TOFRONT <no arg>
  487.     Bring par screen to front
  488.  
  489. -------------------------------------------------------------
  490. TOBACK  <no arg>
  491.     Push par screen to back
  492.  
  493. -------------------------------------------------------------
  494. TRANSLATE [ OFF | ON ]        OFF | ON
  495.     Turn emulation off or on.
  496.  
  497.   TRANSLATE ON
  498.  
  499. -------------------------------------------------------------
  500. UNIT    [0 | 1]            [0 | 1]
  501.     Change to IDE drive 0 (master), or 1 (slave)
  502.  
  503. -------------------------------------------------------------
  504. VERSION <no arg>        current version ID
  505.     Get version info.
  506.  
  507. -------------------------------------------------------------
  508. VIEW    <filename>
  509.     Show an IFF24 or Framestore
  510.     filename can be full path+name, or name in current path
  511.  
  512. -------------------------------------------------------------
  513. WAIT    [number]        RC=0|5
  514.     Wait for anim to complete, or wait for frame number.
  515.     RC will be 5 if not playing, or another arexx program is waiting.
  516.  
  517.  Loop OFF
  518.  say 'starting to play'
  519.  Play
  520.  say 'playing'
  521.  Wait
  522.  say 'Done'
  523.  
  524. -------------------------------------------------------------
  525.  
  526. PAL ARexx commands (Video capture board)
  527.     LUMA
  528.     BLACK
  529.     SATURATION
  530.     HPOS
  531.     RED
  532.     BLUE
  533.     YCDELAY
  534.     SOURCE PAL/SVIDEO/CAV
  535.     FMODE FRAME/F1/F2
  536.     TAKE ON/OFF
  537.     PROCAMP <1-10> [luma black sat hpos red blue yc]
  538.  
  539.  
  540. Keyboard hotkeys:
  541.  
  542.     Del - delete selected file.
  543.     +/- and up/down arrows on keypad - move up/down thru files.
  544.     HOME/END on keypad - select first/last file.
  545.     PgUp/PgDn on keypad - go up/down a page.
  546.     Cursor left/right - move thru anim.
  547.     Shift Cursor left/right - move to start/end of anim.
  548.     Alt Cursor left/right - adjust slow-play speed.
  549.     Alt Cursor down - toggle slow play.
  550.     Cursor up - play
  551.     Cursor down - stop
  552.     Space bar - pause toggle
  553.     C - Convert
  554.     E - E/E
  555.     F - Field/Frame
  556.     G - Grab
  557.     I - still/anim convert mode
  558.     Q - Quit (or ESC)
  559.     R - Rename
  560.     T - TBC-IV
  561.     V - View
  562.  
  563.   Requesters:
  564.     ESC - Cancel
  565.     C   - Cancel
  566.     Return - OK
  567.     O      - OK
  568.  
  569.